home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr53 / 124_01.zip / MSCRIBE.TEX < prev    next >
Text File  |  1993-06-01  |  6KB  |  154 lines
  1. \subhead{Introduction}
  2.  
  3. The {\ss Scribe} macro package is designed to give the tex user
  4. some of the convenience found in the {\ss scribble} text
  5. formatter. The {\ss Scribe} package consists of a set of commands
  6. borrowed from {\ss scribble}, using the {\ss scribble}
  7. philosophy. This philosophy dictates that the user doesn't want
  8. or need detailed control over what goes on the page. Hence, there
  9. are a set of commands that generate environments similar to
  10. things that people like to do in documents. These environments
  11. come in three flavors: inline, vertical and switches. The inline
  12. environments take an argument, and cause no vertical spacing. The
  13. vertical environments start a new line when they are invoked, and
  14. most of them don't take arguments. The switch environments
  15. generally don't take arguments, and don't generate new lines. All
  16. switch environments change the current typeface.
  17.  
  18. In addition to these commands, the {\ss scribe} package includes
  19. all the math mode commands listed in the section of the tex users
  20. manual on math mode. This only includes the symbols of general
  21. interest, and not all of the math mode commands normally
  22. available. If you need these commands, use the {\ss scribe+}
  23. package. This contains all of the math mode commands listed in
  24. the appendix, except for the script characters.
  25.  
  26. \subhead{The Switches}
  27.  
  28. The switches are commands that change the current typeface. These
  29. are:
  30.  
  31. {\describe
  32.  
  33. \bold{r} Change to a roman typeface. This font is the default
  34. typeface for the {\ss scribe} package.
  35.  
  36. \bold{t} Exactly the same as the {\ss r} command. {\ss t} is an
  37. abbreviation for {\it text}, which is the default environment.
  38.  
  39. \bold{b} Change to a bold typeface: {\bf that looks like this.}
  40.  
  41. \bold{i} Change to an italic typeface: {\it that looks like this.}
  42.  
  43. \bold{s} Change to a sans-serif typeface: {\ss that looks like this.}
  44.  
  45. \bold{B} Change to a large bold typeface. This face is used for
  46. major headings in the scribe package, and cannot be gotten to
  47. from the package the manual is set in.
  48. }        % end of the switches
  49.  
  50. \subhead{The Inline Environments}
  51.  
  52. The inline environments all take an argument. These commands
  53. generally cause a change of font over there argument, without
  54. generating any vertical whitespace in the output document. These
  55. are:
  56.  
  57. {\describe
  58.  
  59. \bold{+} The argument to the {\ss +} command is printed
  60. raised above the normal print line, in a position appropriate for
  61. superscripts: for example$\+{this}$ is a super script.
  62.  
  63. \bold{-} The {\ss -} command is identical to the {\ss +} command,
  64. except that it generates subscripts. For example$\-{this}$ is a subscript.
  65.  
  66. \bold{ux} The {\ss ux} command underlines every character in its
  67. argument, \underline{like so.}{}
  68.  
  69. \bold{example} This command prints its arguments in a sans-serif
  70. typeface, imitating (as best as pfont can) a typewriter.
  71. }            % end of the inline environments.
  72.  
  73. \subhead{The Vertical Environments}
  74.  
  75. The vertical environments all cause a vertical skip when they are
  76. invoked. In general, they correspond to the pieces of a document
  77. - headings, quotes, verse, addresses, etc.  Some of these
  78. commands expect an argument, and act only on that argument.
  79. These are noted in the following list. Those that do not take
  80. arguments cause an tex environment change, and should be have
  81. a pair of curly braces to designate the text the command applies
  82. to, like so: {\ss \{\\command text for it to apply to\}.}
  83.  
  84. {\describe
  85.  
  86. \bold{center} Centers its argument. This command starts a new
  87. line for its argument, and a second new line for the text
  88. following its argument.
  89.  
  90. \bold{majorhead} This command prints its argument in the {\ss B}
  91. typeface, centered on the page. It leaves 2/3's of an inch above
  92. and 1/6 of an inch plus paragraph spacing below its argument. The
  93. piece of text that follows this command will be indented as a paragraph.
  94.  
  95. \bold{head} This command prints its argument in the {\ss b}
  96. typeface, left justified. It leaves 1/3 of an inch above and 1/6
  97. of an inch plus paragraph spacing below its argument. The piece
  98. of text that follows this command will be indented a paragraph.
  99.  
  100. \bold{subhead} This command prints its argument in the {\ss i}
  101. typeface, left justified. It leaves 1/6 of an inch above and
  102. paragraph spacing below its argument. The piece of text that
  103. follows this command will be indented as a paragraph.
  104.  
  105. \bold{address} Non-filled, left justified environment. This
  106. environment is indented approximately 4 inches from the left
  107. margin. It is suitable for the return address on a letter.
  108.  
  109. \bold{closing} Identical to the {\ss address} environment, with a
  110. name more appropriate for the closing of a letter.
  111.  
  112. \bold{verbatim} This environment is non-filled. Other than that,
  113. it is identical to the surrounding environment. It is suitable
  114. for including text fragments that you don't want formatted.
  115.  
  116. \bold{display} Identical to {\ss verbatim}, except that the font
  117. is changed to the {\ss s} font. Usefull for including program
  118. text, or long examples.
  119.  
  120. \bold{verse} A non-filled environment indented by 1/2 an inch. As
  121. its name indicates, it is suitable for verse.
  122.  
  123. \bold{quote} A filled environemt indented by 1/2 an inch.
  124. Suitable for use with long text quotations.
  125.  
  126. \bold{describe} This is an outdented environment. It is useful
  127. for a list of descriptions. In this environment, the {\ss @}
  128. command is useful for the first object being described. The {\ss
  129. @} command causes a change to a bold typeface, and insures that
  130. at least one space follows its argument.
  131. }            % end of the vertical environments
  132.  
  133. \subhead{The Rest of the Commands}
  134.  
  135. The following commands are added to make users of scribble and
  136. scribe more comfortable.
  137.  
  138. {\describe
  139.  
  140. \bold{newpage} Skip to the top of the next page.
  141.  
  142. \bold{blankspac} Skip left by the number of points specified by
  143. its argument.
  144.  
  145. \bold{blankline} Skip down by the number of points specified by
  146. its argument.
  147.  
  148. \bold{style} The arguments of the {\ss style} command is passed
  149. to {\FF Fancy Font} as parameters. It is used exactly like the
  150. builtin {\ss ff} command.
  151. }            % end of the miscellanious crap
  152. suitable for verse.
  153.  
  154. \bold{quote} A filled environemt indented by 1/2